[]
获取当前 k8s 部署的指标信息。
返回值
状态码: 200
成功
状态码: 400
错误的请求
状态码: 404
未找到
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| apiVersion可为空 | string | 定义对象此表示形式的版本化模式。 | |
| kind可为空 | string | 定义此对象所代表的 REST 资源。 | |
| metadata | V1ObjectMeta | ||
| items可为空 | PodMetrics | Pod 指标列表。 |
ObjectMeta 是所有持久化资源必须具有的元数据，其中包括用户必须创建的所有对象。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| annotations可为空 | string | 注解是一种非结构化的键值映射，与资源一起存储，可由外部工具设置，用于存储和检索任意元数据。注解不可查询，并且在修改对象时应保留。更多信息：https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations | |
| creationTimestamp可为空 | ISO DateTime Sting | CreationTimestamp 是一个时间戳，表示此对象创建时的服务器时间。它不能保证在不同的操作中按 happens-before 顺序设置。客户端不得设置此值。它采用 RFC3339 格式，时间单位为 UTC。此值由系统填充，只读。列表的值为 null。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions#metadata | |
| deletionGracePeriodSeconds可为空 | int64 | 此对象在从系统中移除之前允许正常终止的秒数。仅当同时设置了 deletionTimestamp 时才设置。此值只能缩短。只读。 | |
| deletionTimestamp可为空 | ISO DateTime Sting | DeletionTimestamp 是 RFC 3339 中定义的日期和时间，表示此资源将被删除的时间。当用户请求优雅删除时，服务器会设置此字段，客户端无法直接设置。预期资源会在此字段指定的时间之后被删除（不再显示在资源列表中，也无法通过名称访问），前提是终结器列表为空。只要终结器列表包含项目，删除操作就会被阻止。一旦设置了 deleteTimestamp，该值就不能被取消设置或设置为更远的时间，尽管可以缩短时间或在此时间之前删除资源。例如，用户可以请求在 30 秒后删除一个 Pod。Kubelet 将通过向 Pod 中的容器发送优雅终止信号来响应此请求。 30 秒后，Kubelet 将向容器发送硬终止信号 (SIGKILL)，并在清理完成后从 API 中移除该 Pod。如果存在网络分区，则此对象可能在此时间戳之后仍然存在，直到管理员或自动化进程确定该资源已完全终止。如果未设置，则表示尚未请求优雅删除该对象。 当请求优雅删除时，系统会填充此值。只读。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions#metadata |
|
| finalizers可为空 | Array<string> |
在从注册表中删除对象之前，该列表必须为空。每个条目都是负责从列表中删除该条目的组件的标识符。如果对象的删除时间戳不为空，则只能删除此列表中的条目。终结器可以按任意顺序处理和删除。由于顺序限制会引入终结器卡住的重大风险，因此不强制执行顺序。终结器列表是一个共享字段，任何具有权限的参与者都可以重新排序。如果按顺序处理终结器列表，则可能导致列表中第一个终结器的组件等待列表中后续终结器的组件发出的信号（字段值、外部系统或其他），从而导致死锁。如果没有强制排序，终结器可以自由地相互排序，并且不会受到列表顺序更改的影响。 | |
| generateName可为空 | string | GenerateName 是一个可选前缀，服务器使用它来生成一个唯一的名称，仅当未提供 Name 字段时才使用。如果使用此字段，返回给客户端的名称将与传递的名称不同。此值还会与一个唯一的后缀组合。提供的值与 Name 字段具有相同的验证规则，并且可能会因服务器端所需的后缀长度而被截断，以确保该值的唯一性。 如果指定了此字段并且生成的名称已存在，服务器将返回 409。 仅当未指定 Name 时才应用。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions#idempotency |
|
| generation可为空 | int64 | 代表所需状态特定世代的序列号。 由系统填充。只读。 |
|
| labels可为空 | string | 用于组织和分类（范围和选择）对象的字符串键值对映射。可能与复制控制器和服务的选择器匹配。更多信息：https://kubernetes.io/docs/concepts/overview/working-with-objects/labels | |
| managedFields可为空 | V1ManagedFieldsEntry | ManagedFields 将工作流 ID 和版本映射到该工作流管理的字段集。这主要用于内部管理，用户通常无需设置或理解此字段。工作流可以是用户名称、控制器名称或特定应用路径的名称，例如“ci-cd”。字段集始终采用工作流在修改对象时使用的版本。 | |
| name可为空 | string | 名称在命名空间内必须唯一。创建资源时必须指定名称，但某些资源可能允许客户端请求自动生成合适的名称。名称主要用于创建幂等性和配置定义，不可更新。更多信息：https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names | |
| namespaceProperty可为空 | string | 命名空间定义了每个名称必须唯一的范围。空的命名空间等同于“默认”命名空间，但“默认”是规范表示。并非所有对象都必须限定在某个命名空间内——对于这些对象，此字段的值将为空。 必须是 DNS_LABEL 类型。不可更新。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces |
|
| ownerReferences可为空 | V1OwnerReference | 此对象所依赖的对象列表。如果列表中的所有对象都已被删除，则此对象将被垃圾回收。如果此对象由控制器管理，则此列表中的一个条目将指向该控制器，并且 controller 字段设置为 true。一个对象只能有一个管理控制器。 |
|
| resourceVersion可为空 | string | 一个不透明值，表示此对象的内部版本，客户端可以使用该值来确定对象何时发生更改。可用于乐观并发、变更检测以及对单个或一组资源的监视操作。客户端必须将这些值视为不透明值，并以未修改的形式传递回服务器。它们可能仅对特定资源或一组资源有效。 由系统填充。只读。客户端必须将该值视为不透明值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions#concurrency-control-and-consistency |
|
| selfLink可为空 | string | 已弃用：selfLink 是一个遗留的只读字段，系统不再填充该字段。 | |
| uid可为空 | string | UID 是此对象在时间和空间上的唯一标识。它通常由服务器在资源成功创建时生成，并且不允许在 PUT 操作中更改。 由系统填充。只读。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
描述从指标服务器 API 拉取的 pod 的资源使用情况指标。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| metadata | V1ObjectMeta | ||
| timestamp可为空 | ISO DateTime Sting | 指标采集的时间戳。 | |
| window可为空 | string | 收集指标的时间间隔。 | |
| containers可为空 | ContainerMetrics | 容器指标列表。 |
ManagedFieldsEntry 是一个工作流 ID、一个字段集以及该字段集所应用的资源的组版本。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| apiVersion可为空 | string | APIVersion 定义了此字段集所适用的资源版本。 格式与顶级 APIVersion 字段一样，为“group/version”。跟踪字段集的版本是必要的，因为它无法自动转换。 |
|
| fieldsType可为空 | string | FieldsType 是区分不同字段格式和版本的标识符。 目前只有一个可能的值：“FieldsV1” |
|
| fieldsV1可为空 | any | FieldsV1 包含“FieldsV1” type 中描述的第一个 JSON 版本格式。 |
|
| manager可为空 | string | 管理器是管理这些字段的工作流的标识符。 | |
| operation可为空 | string | 操作是指导致创建此 ManagedFieldsEntry 的操作类型。此字段的唯一有效值为“应用”和“更新”。 | |
| subresource可为空 | string | 子资源是用于更新该对象的子资源的名称；如果对象是通过主资源更新的，则该字段为空字符串。此字段的值用于区分不同的管理器，即使它们名称相同。例如，状态更新与使用相同管理器名称的常规更新是不同的。请注意，APIVersion 字段与子资源字段无关，它始终对应于主资源的版本。 | |
| time可为空 | ISO DateTime Sting | 时间戳记录的是 ManagedFields 条目添加时的时间戳。如果添加了字段、管理员更改了任何已拥有字段的值或删除了字段，时间戳也会更新。但如果某个字段因为被其他管理员接管而从条目中移除，则时间戳不会更新。 |
OwnerReference 包含足够的信息，可让您识别拥有对象。 拥有对象必须与依赖对象位于同一命名空间中，或者 是集群范围的，因此没有命名空间字段。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| apiVersion可为空 | string | 引用对象的 API 版本。 | |
| blockOwnerDeletion可为空 | Boolean | 如果为真，且所有者拥有“foregroundDeletion”终结器，则在移除此引用之前，所有者无法从键值存储中删除。请参阅 https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion，了解垃圾回收器如何处理此字段并强制执行前台删除。默认值为 false。要设置此字段，用户需要拥有所有者的“delete”权限，否则将返回 422（无法处理的实体）。 | |
| controller可为空 | Boolean | 如果属实，则此引用指向管理控制器。 | |
| kind可为空 | string | 指称对象类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions#types-kinds |
|
| name可为空 | string | 引用对象的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
|
| uid可为空 | string | 被引用对象的 UID。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
从指标服务器 API 获取容器的资源使用指标。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name可为空 | string | 定义与 pod.spec.containers 中的名称对应的容器名称。 | |
| usage可为空 | string | 资源使用情况。 |
服务器插件错误
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code可为空 | string | 错误代码 | |
| message可为空 | string | 错误信息 | |
| context可为空 | string | 错误上下文 | |
| innerError | ServerPluginError | ||
| extensions可为空 | any | 扩展结果 |
